package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.ContractPayLogAddDTO;
import org.jsola.contract.dto.ContractPayLogUpdateDTO;
import org.jsola.contract.query.ContractPayLogQuery;
import org.jsola.contract.vo.ContractPayLogListVO;
import org.jsola.contract.vo.ContractPayLogVO;
import org.jsola.core.Page;
import org.jsola.core.Result;

import java.util.List;

/**
 * 租户电子合同充值记录
 *
 * @author JanusMix
 */
@Api(tags = "contract-租户电子合同充值记录")
public interface IContractPayLogControllerAPI {

    /**
     * 新增租户电子合同充值记录
     * @param contractPayLogAddDTO 租户电子合同充值记录新增实体
     * @return 租户电子合同充值记录展示对象
     */
    @ApiOperation(value = "新增租户电子合同充值记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractPayLogAddDTO", dataType = "ContractPayLogAddDTO", value = "新增租户电子合同充值记录", paramType = "body")
    })
    Result<ContractPayLogVO> save(ContractPayLogAddDTO contractPayLogAddDTO);


    /**
     * 修改租户电子合同充值记录
     * @param contractPayLogUpdateDTO 租户电子合同充值记录
     * @return 更新数量
     */
    @ApiOperation(value = "修改租户电子合同充值记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractPayLogUpdateDTO", dataType = "ContractPayLogUpdateDTO", value = "修改租户电子合同充值记录", paramType = "body")
    })
    Result<Integer> update(ContractPayLogUpdateDTO contractPayLogUpdateDTO);




    /**
     * 删除单个租户电子合同充值记录，彻底删除
     * @param contractPayLogId 租户电子合同充值记录id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个租户电子合同充值记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractPayLogId", dataType = "Long", value = "租户电子合同充值记录id", paramType = "path")
    })
    Result<Integer> delete(Long contractPayLogId);


    /**
     * 批量删除租户电子合同充值记录，彻底删除
     * @param contractPayLogIds 租户电子合同充值记录id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除租户电子合同充值记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractPayLogIds", dataType = "Long[]", value = "租户电子合同充值记录id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] contractPayLogIds);


    /**
     * 根据租户电子合同充值记录id查询租户电子合同充值记录详情
     * @param contractPayLogId 租户电子合同充值记录id
     * @return 租户电子合同充值记录详情
     */
    @ApiOperation(value="根据租户电子合同充值记录id查询租户电子合同充值记录详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractPayLogId", dataType = "Long", value = "租户电子合同充值记录id", paramType = "path")
    })
    Result<ContractPayLogVO> findById(Long contractPayLogId);


    /**
     * 查询租户电子合同充值记录
     * @param contractPayLogQuery 租户电子合同充值记录查询参数
     * @return page
     */
    @ApiOperation(value="查询租户电子合同充值记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractPayLogQuery", dataType = "ContractPayLogQuery", value = "租户电子合同充值记录查询参数", paramType = "query")
    })
    Result<List<ContractPayLogListVO>> listAll(ContractPayLogQuery contractPayLogQuery);


     /**
     * 分页查询租户电子合同充值记录
     * @param contractPayLogQuery 租户电子合同充值记录查询参数
     * @return page
     */
    @ApiOperation(value="分页查询租户电子合同充值记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractPayLogQuery", dataType = "ContractPayLogQuery", value = "租户电子合同充值记录查询参数", paramType = "query")
    })
    Result<Page<ContractPayLogListVO>> page(ContractPayLogQuery contractPayLogQuery);


}

